/*
 * Copyright (c) 2017, 2025, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package at.ssw.dataflow.options;

/**
 * Interface for classes that want to publish options.
 *
 * @author Stefan Loidl
 */
public interface OptionProvider {

    /**
     * Returns all keys for existing options.
     */
    public String[] getOptionKeys();

    /**
     * Sets the option defined by key.
     */
    public boolean setOption(String key, Object value);

    /**
     * Gets the option defined by key.
     */
    public Object getOption(String key);

    /**
     * Returns the class the option should passed as.
     */
    public Class getOptionClass(String key);

    /**
     * Returns a validator for a option.
     */
    public Validator getOptionValidator(String key);

    /**
     * Return the description for the option.
     */
    public String getOptionDescription(String key);
}
